becu-interop-platform-api

1.0.x
(0 reviews)

Publish Asset to Public Portal

Description

This page consists of the information regarding the operation performed to retreive asset versions available on Anypoint Exchange and make asset versions available on Anypoint Exchange Public Portal.

Endpoints

  • GET /assets/version/{assetId}
  • PUT /assets/version/{assetId}

API Design Endpoint Sequence Diagram

BECU Interop Platform API orchestrates API calls to the internal-Anypoint Platform and Anypoint Exchange APIs to retreive a list of asset versions exposed in Exchange. The below diagram depicts the various platform APIs invoked for this process.

Get Asset Versions

resources/image-f885343c-381c-477c-9526-a9f1775a983b.png

Publish Asset Versions

resources/image-61fa8977-5402-4d43-b2b4-90bbfd33e0e6.png

Get Asset Versions

Using GET /assets/version/{assetId} endpoint, we can retrieve all the versions of an asset in Exchange.

The following fields are retrieved:

  • assetId: The name of the asset
  • minorVersion: The minor version of the asset (ex: "1.1")
  • versionGroup: The major version of the asset (ex: "v1")
  • isPublic: Boolean indicating if asset is available in Public Portal
  • isSnapshot: Boolean indicating if version leans toward a stable product to release, default false
  • statuses: Array of asset states, this array contains the status of the latest stable/deprecated versions, possible values are:
    • "published"
    • "deprecated"

Asset Version publishing to Public Portal

Using PUT /assets/version/{assetId} endpoint, we can publish specific versions of an asset to Public Portal.

A body must be passed in the request to indicate the asset versions to publish in Public Portal, major versions should be enclosed in an array, with the keyname as: "versionGroup".

Example below:

{
  "versionGroup": ["v1", "v2"]
}

This example will publish major versions v1 and v2

Connectors & Common API Dependency

The BECU Interop Platform API, is consuming multiple connectors and Anypoint Platform REST APIs.

Below are the list of connectors which this API is consuming:

  • HTTP Connector
  • Transform Message
  • JSON Logger

Downstream Dependencies

Anypoint Platform REST APIs

Anypoint Platform Login API

Anypoint Exchange API for

  - Get Asset Versions
  - Publish Asset Version to Public Portal

Reviews